/*
 * Copyright 2007-2008 Michele Mostarda ( michele.mostarda@gmail.com ).
 * All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the 'License');
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an 'AS IS' BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.asemantics.anthill.chatconsole;

import org.asemantics.anthill.CommandListenerTask;

/**
 * Defines a {@link org.asemantics.anthill.chatconsole.ChatCommandLine} command.
 */
public interface Command {

    /**
     * Executes the current command on the given arguments providing a console
     * to return output.
     *
     * @param clt the listener task providing context to execute the command.
     * @param chatConsole the output console.
     * @param commandName the name used to invoke this command.
     * @param arguments the command arguments.
     * @return returns the success status of the command.
     */
    public boolean execute( CommandListenerTask clt, ChatConsoleOutputStream chatConsole, String commandName, String[] arguments);

}
